文件上传
1. 使用到的工具类:
值得注意的是fileupload只支持javax,并不支持jakarta。
故需将tomcat降低到10以下。
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
2. 注意事项
- 为了保证服务器安全,上传的文件应该放在外界无法直接访问的目录下,比如放在WEB-INF目录下。
- 为了防止文件覆盖现象的发生,要为上传文件产生一个唯一的文件名。(时间戳/UUID/MD5/位运算...)
- 要限制上传文件的最大值。
- 可以限制上传文件的类型,在收到上传文件名的时候,判断后缀名是否合法。
应选方式:post
get:上传文件大小有限制 4kb,只能传递字符
post:上传文件大小无限制,可以传递一切东西
3. 文件上传需要用到的
3个类+1个属性
- ServletFileUpload:在后端获取文件上传的文件数据,并将上传文件数据的表单中的每个输入项都封装为一个FileItem对象
- FileItem:负责封装数据表单中的每个输入项。
- DiskFileItemFactory:使用ServletFileUpload解析前端表单传过来的文件数据时需要使用到DiskFileItemFactory对象,所以在获取ServletFileUpload对象之前我们需要先获取DiskFileItemFactory对象
- FileItemFactory属性:ServletFileUpload对象的一个属性
4. 常用方法
// isFormField方法用于判断FileItem类对象封装的数据是一个普通文本表单
// 还是一个文件表单,如果是普通表单字段则返回true,否则返回false
boolean isFormField();//即:只要是上传的文件,返回的就是false
// getFieldName方法用于返回表单标签name属性的值。
String getFieldName();//获取这个input的name属性值
// getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
String getString();//用字符串存储文件的数据流
// getName方法用于获得文件上传字段中的文件名
String getName();
// 以流的形式返回上传文件的数据内容。
InputStream getInputStream()
// delete方法用来清空FileItem类对象中存放的主体内容
// 如果主体内容被保存在临时文件中,delete方法将删除该临时文件。
void delete();
5. 步骤:
前端表单需要加
enctype="multipart/form-data
字段<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data"> 上传用户:<p><input type="text" name="username"></p> <p><input type="file" name="file1"></p> <p><input type="file" name="file2"></p> <p><input type="submit"> | <input type="reset"></p> </form>
文件上传Servlet
```java package com.gs.servlet;
import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.FileUploadException; import org.apache.commons.fileupload.ProgressListener; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload;
import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.List; import java.util.UUID;
/**
- @author admin
@date 2021/9/10 10:46 上午 */ public class FileServlet extends HttpServlet { @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// 判断文件是否是普通表单还是带文件的表单 if (!ServletFileUpload.isMultipartContent(req)) { return; } String msg = null; try { // 创建上传的文件路径,放在用户无法直接访问的地方 String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload"); File uploadFile = new File(uploadPath); if (!uploadFile.exists()) { uploadFile.mkdir(); } // 缓存,存放临时文件 // 如果文件超过预期大小,放到临时文件中,过几天自动删除,或者提醒用户转存为永久 String tmpPath = this.getServletContext().getRealPath("/WEB-INF/tmp"); File tmp = new File(tmpPath); if (!tmp.exists()) { tmp.mkdir(); } // 处理上传的文件,一般要通过流来获取 // 可以使用request.getInputStream(),原生态的文件上传流获取,但是十分麻烦 // 可以使用Apache的文件上传组件来实现,common-fileupload,需要依赖于common-io组件 /* ServletFileUpload负责处理上传文件的额数据,并将表单中给每一个输入项封装成一个FileItem对象。 在使用ServletFileUpload对象解析请求时候需要DiskFileItemFactory对象, 所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象 通过ServletFileUpload对象的构造方法或setFileItemFactory()方法 设置ServletFileUpload对象的fileItemFactory属性 */
DiskFileItemFactory diskFileItemFactory = getDiskFileItemFactory(tmp);
ServletFileUpload upload = getServletFileUpload(diskFileItemFactory);
msg = uploadParseRequest(upload, req, uploadPath);
} catch (FileUploadException e) {
e.printStackTrace();
msg = "上传失败!";
}
req.setAttribute("msg", msg);
req.getRequestDispatcher("info.jsp").forward(req, resp);
}
private String uploadParseRequest(ServletFileUpload upload, HttpServletRequest req, String uploadPath) throws IOException, FileUploadException {
String msg;
// 4. 处理上传文件
// 把前端请求解析,封装成一个FileItem对象,需要从ServletFileUpload对象中获取
List<FileItem> fileItems = upload.parseRequest(req);
for (FileItem fileItem : fileItems) {
if (fileItem.isFormField()) { // 普通表单
String name = fileItem.getFieldName();
String value = fileItem.getString("UTF-8"); // 处理乱码
System.out.println(name + ":" + value);
} else { // 文件表单
// 处理文件
String uploadFileName = fileItem.getName();
if (null == uploadFileName || uploadFileName.trim().equals("")) {
continue;
}
// 获得上传的文件名
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
// 获得文件的后缀名
String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
// 可以使用UUID(唯一识别的通用码),保证文件名唯一
// UUID.randomUUID(),随机生成一个唯一识别通用码
// 网络传输的东西,都需要序列化
// implements java.io.Serializable
String uuidPath = UUID.randomUUID().toString();
// 存放地址
String realPath = uploadPath + "/" + uuidPath;
// 给每个文件创建一个对应的文件夹
File realPathFile = new File(realPath);
if (!realPathFile.exists()) {
realPathFile.mkdir();
}
// 文件传输
InputStream inputStream = fileItem.getInputStream();
FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);
byte[] buffer = new byte[1024 * 1024];
int len = 0;
while ((len = inputStream.read(buffer)) > 0) {
fos.write(buffer, 0, len);
}
fos.close();
fos.close();
System.out.println("fileName 上传成功!");
}
}
msg = "上传成功";
return msg;
}
private ServletFileUpload getServletFileUpload(DiskFileItemFactory diskFileItemFactory) {
// 3. 获取ServletFileUpload
ServletFileUpload upload = new ServletFileUpload(diskFileItemFactory);
// 监听文件上传速度
upload.setProgressListener(new ProgressListener() {
@Override
// pBytesRead: 已经读取到的文件大小
// pContentLength:文件大小
public void update(long bytesRead, long contentLength, int items) {
System.out.println("总大小" + contentLength + " 已上传" + bytesRead);
}
});
// 处理乱码问题
upload.setHeaderEncoding("UTF-8");
// 设置单个文件的最大值
// 10M
upload.setFileSizeMax(1024 * 1024 * 10);
// 设置总共能够上传文件的大小
upload.setSizeMax(1024 * 1024 * 10);
return upload;
}
private DiskFileItemFactory getDiskFileItemFactory(File tmp) {
// 1. 创建DiskFileItemFactory对象,处理文件上传路径或者大小限制
DiskFileItemFactory diskFileItemFactory = new DiskFileItemFactory();
// 2. 通过这个工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中
// 缓冲区大小为1M
diskFileItemFactory.setSizeThreshold(1024 * 1024);
// 临时目录的保存目录,需要一个file
diskFileItemFactory.setRepository(tmp);
return diskFileItemFactory;
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
this.doGet(req, resp);
}
} ```